Repository navigation
Template 0.1.32: the user docs link to the guide that owns a topic - #56
Merged
Merged
Conversation
tools_bridge.md no longer repeats the plugins' install situation, the Tools authoring guide (form markers, outputs, check/test) or the Tools pin's version. It keeps what the template owns (where an app declares its tools, what the installer does, where the pin is set and how it is moved) and links to the owner guides: the Site's image-software, napari, Fiji and QuPath guides, and LabConstrictor-Tools docs/AUTHORING.md (on GitHub for now). install.md links to the image-software guide; napari in lower case. Migration 0.1.31 -> 0.1.32 delivers it: tools_bridge.md is replaced only when it is the 0.1.31 template file, install.md and the docs README get exact-text edits, customised files are SKIPPED, line endings are kept. Design note migration_0_1_32.md, tests, and before_0_1_32 chained into the older test helpers. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Template 0.1.32: the template's user docs follow the one-owner rule agreed on 2026-11-16. Each topic is written on one page, and every other page links to it. The template owns "Install an app" (
install.md) and the build guides. It does not own the plugins' install steps or how to write a tool.What changed
.tools/docs/tools_bridge.mdis rewritten around what the template owns:<package>_lc_toolsmodule undersrc/, a short example, keeping imports light, and naming the hosts inlabconstrictor-app.yaml.post_install,pre_uninstall, and what happens when a step fails.LC_TOOLS_PINin both scripts, linked),LC_TOOLS_SPEC, and how maintainers move the pin.The page now links to the owner guides instead of repeating them:
check/testcommands and HOST_FEATURES → Writing tools, on GitHub for now, until the Site publishes it.The Tools pin's version (
v0.3.0-alpha.2) is no longer written in any doc. The scripts are the only place it is set, and the page links to them. This also drops the maintainer step "update the tag in this paragraph"..tools/docs/install.md: "Where the app is listed" writes napari in lower case and ends with one link to the image-software guide..tools/docs/README.md: the tools guide's entry writes napari in lower case.Also checked, with nothing to change: the other user pages of
.tools/docsand the template README.app_manifest.mdnames a plugin version only as an example value ofhost_requirements, which is the template's own field.The plugin guides are owned by the plugin repositories (LabConstrictor-napari, LabConstrictor-Fiji and LabConstrictor-QuPath
docs/user-guide.md; the overview and the authoring guide by LabConstrictor-Tools). The Site publishes them. This PR only links to them.Delivered to apps: migration 0.1.31 → 0.1.32
.template_sync/migrations/v0_1_31_to_v0_1_32.pyand itsmanifest.yamlentry (template_version: 0.1.32).tools_bridge.mdis replaced whole, but only when it is exactly the 0.1.31 template file (compared with LF endings). The frozen copies are in.template_sync/resources/v0_1_31_to_v0_1_32/(new andprevious/). A customised file is left alone with aSKIPPEDline.install.mdand the docsREADME.mdget exact-text edits. A file without that text gets aSKIPPEDline, and a partly customised one gets the edits that apply..tools/docs/migration_0_1_32.md. It is not listed in the docs README.tests/test_template_sync_0_1_32.py.tests/_v0_1_32.py(before_0_1_32) is chained intobefore_0_1_31, so the older frozen-resource tests still compare against the right text. Older exact-version assertions were already loosened. Three older tests read the livetools_bridge.md/install.mddirectly (test_template_sync_0_1_17.py,_0_1_28.py,_0_1_30.py). They now read the 0.1.31 text throughbefore_0_1_32, so each still checks what it checked before.before_0_1_32swaps the whole file back only when it is the 0.1.32 file, becausebefore_0_1_20runs the chain a second time on older text.Verification
ruff check .template_sync .tools/python tests: all checks passed.python -m mypy .template_sync .tools/python tests: no issues in 89 files.python -m pytest tests -q, CI's pins, Python 3.11, Windows), compared with a baseline on cleanorigin/main(87b4b97): 55 failed, 410 passed on this branch against 55 failed, 394 passed on clean main. The 55 failures are the same tests in both runs (they fail on clean main on Windows), so this change adds no failures. The 16 new tests pass.sync.py --from-version 0.1.31 --to-version 0.1.32, then run again):Follow-ups (not in this PR)
AUTHORING.mdas a guide, a small migration should swap the GitHub address intools_bridge.mdfor the Site one..tools/docs/install.md: no migration ever delivered it to them.🤖 Generated with Claude Code